REST API to Interact with Staging Area

A REST API allows staging area management and read, write and delete operations on packages through HTTP.

DS Package Installer webapp is secured using basic Authentication mechanism. A proper user with appropriate privilege (by default TAFJAdmin) should be defined within the application server context. That is for JBoss 7 EAP, you need to make use of add-user tooling by creating a user part of the TAFJAdmin group.

The application context root is /DSPackageInstaller.

The REST API is documented below and also available online since the application is deployed. It can be accessed by using following URL: /DSPackageInstaller/html/help.html.

API Description

This section lists the operations that can be performed by REST API on the DSPackageInstaller.war webapp.

Examples of REST API Operations using POSTMAN Client

This section shows few examples of REST API operations on DS Package Installer.

DS Packager Installer Servlet

This section gives a brief overview about DS Package Installer servlet.

Staging Area Management

This section gives a brief overview about Staging area management.

Package Parsing Operations

This section describes the package information and staging operations.

Package Staging Operations

This section describes the Read, Write and Delete operations on a package.